home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zsysv.z / zsysv
Encoding:
Text File  |  2002-10-03  |  6.1 KB  |  199 lines

  1.  
  2.  
  3.  
  4. ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))                                                            ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZSYSV - compute the solution to a complex system of linear equations A *
  10.      X = B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZSYSV( UPLO, N, NRHS, A, LDA, IPIV, B, LDB, WORK, LWORK, INFO
  14.                        )
  15.  
  16.          CHARACTER     UPLO
  17.  
  18.          INTEGER       INFO, LDA, LDB, LWORK, N, NRHS
  19.  
  20.          INTEGER       IPIV( * )
  21.  
  22.          COMPLEX*16    A( LDA, * ), B( LDB, * ), WORK( * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      ZSYSV computes the solution to a complex system of linear equations A * X
  39.      = B, where A is an N-by-N symmetric matrix and X and B are N-by-NRHS
  40.      matrices.
  41.  
  42.      The diagonal pivoting method is used to factor A as
  43.         A = U * D * U**T,  if UPLO = 'U', or
  44.         A = L * D * L**T,  if UPLO = 'L',
  45.      where U (or L) is a product of permutation and unit upper (lower)
  46.      triangular matrices, and D is symmetric and block diagonal with 1-by-1
  47.      and 2-by-2 diagonal blocks.  The factored form of A is then used to solve
  48.      the system of equations A * X = B.
  49.  
  50.  
  51. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  52.      UPLO    (input) CHARACTER*1
  53.              = 'U':  Upper triangle of A is stored;
  54.              = 'L':  Lower triangle of A is stored.
  55.  
  56.      N       (input) INTEGER
  57.              The number of linear equations, i.e., the order of the matrix A.
  58.              N >= 0.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))                                                            ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      NRHS    (input) INTEGER
  75.              The number of right hand sides, i.e., the number of columns of
  76.              the matrix B.  NRHS >= 0.
  77.  
  78.      A       (input/output) COMPLEX*16 array, dimension (LDA,N)
  79.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading N-
  80.              by-N upper triangular part of A contains the upper triangular
  81.              part of the matrix A, and the strictly lower triangular part of A
  82.              is not referenced.  If UPLO = 'L', the leading N-by-N lower
  83.              triangular part of A contains the lower triangular part of the
  84.              matrix A, and the strictly upper triangular part of A is not
  85.              referenced.
  86.  
  87.              On exit, if INFO = 0, the block diagonal matrix D and the
  88.              multipliers used to obtain the factor U or L from the
  89.              factorization A = U*D*U**T or A = L*D*L**T as computed by ZSYTRF.
  90.  
  91.      LDA     (input) INTEGER
  92.              The leading dimension of the array A.  LDA >= max(1,N).
  93.  
  94.      IPIV    (output) INTEGER array, dimension (N)
  95.              Details of the interchanges and the block structure of D, as
  96.              determined by ZSYTRF.  If IPIV(k) > 0, then rows and columns k
  97.              and IPIV(k) were interchanged, and D(k,k) is a 1-by-1 diagonal
  98.              block.  If UPLO = 'U' and IPIV(k) = IPIV(k-1) < 0, then rows and
  99.              columns k-1 and -IPIV(k) were interchanged and D(k-1:k,k-1:k) is
  100.              a 2-by-2 diagonal block.  If UPLO = 'L' and IPIV(k) = IPIV(k+1) <
  101.              0, then rows and columns k+1 and -IPIV(k) were interchanged and
  102.              D(k:k+1,k:k+1) is a 2-by-2 diagonal block.
  103.  
  104.      B       (input/output) COMPLEX*16 array, dimension (LDB,NRHS)
  105.              On entry, the N-by-NRHS right hand side matrix B.  On exit, if
  106.              INFO = 0, the N-by-NRHS solution matrix X.
  107.  
  108.      LDB     (input) INTEGER
  109.              The leading dimension of the array B.  LDB >= max(1,N).
  110.  
  111.      WORK    (workspace/output) COMPLEX*16 array, dimension (LWORK)
  112.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  113.  
  114.      LWORK   (input) INTEGER
  115.              The length of WORK.  LWORK >= 1, and for best performance LWORK
  116.              >= N*NB, where NB is the optimal blocksize for ZSYTRF.
  117.  
  118.              If LWORK = -1, then a workspace query is assumed; the routine
  119.              only calculates the optimal size of the WORK array, returns this
  120.              value as the first entry of the WORK array, and no error message
  121.              related to LWORK is issued by XERBLA.
  122.  
  123.      INFO    (output) INTEGER
  124.              = 0: successful exit
  125.              < 0: if INFO = -i, the i-th argument had an illegal value
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))                                                            ZZZZSSSSYYYYSSSSVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              > 0: if INFO = i, D(i,i) is exactly zero.  The factorization has
  141.              been completed, but the block diagonal matrix D is exactly
  142.              singular, so the solution could not be computed.
  143.  
  144. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  145.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  146.  
  147.      This man page is available only online.
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.